schm-external-hr-eapi

1.0.x
(0 reviews)

schm-external-hr-eapi 中文文档

应用描述: HR信息，包括员工、区域、部门信息查询，供外部使用
开发环境地址: https://schm-api-dev.shiseido.cn/schm-external-hr-eapi
测试环境地址: https://schm-api-test.shiseido.cn/schm-external-hr-eapi
生产环境地址: https://schm-api.shiseido.cn/schm-external-hr-eapi

目录

1.权限认证

所有请求标头都必须包含以下键值参数作为身份验证信息。您需要向管理员申请此信息。

client_id: fa98****3452
client_secret: 108b****41f2

2.接口列表:

请求地址说明
GET /employee查询员工信息
GET /division查询division信息
GET /department查询department信息
GET /employee_hk查询HK员工信息
GET /division_hk查询HK division信息
GET /department_hk查询HK department信息

3.接口描述

3.1 员工信息查询

接口请求地址: /employee
接口描述: 查询员工数据。
接口调用方式: GET

请求参数说明:

字段名字段说明是否必填
pageSize单页返回数据条目，默认100N
pageNo当前页码，从0开始，默认0N
hiredate入职日期，格式yyyy-MM-dd，如：2024-07-31N
person_id输入员工号，可用于查询单个人员的信息N
company_code公司编码N
empcode工号N
empdistrict所属地区N
quitdate离职日期，格式yyyy-MM-dd，如：2024-07-25N
mlevel_code组织职务(Code)N
servicestatus状态N
update_time信息变动时间，格式yyyy-MM-dd，如：2024-07-25N

请求体结构示例

https://schm-api.shiseido.cn/schm-external-hr-eapi/employee?pageSize=10&pageNo=0

返回结构说明

字段含义字段名称
公司编码company_code
公司略称company_short_name
工号empcode
姓名c_name
姓名_ene_name
姓(EN)last_name_en
名(EN)first_name_en
公司名称company_name
公司名称_encompany_name_en
本部编码divisioncode3
本部名称Division_name
本部名称_enDivision_name_en
部门编码departmentcode4
部门名称Department_name
部门名称_enDepartment_name_en
子部门编码sub_departmentcode5
子部门名称Sub_Department_name
子部门名称_enSub_Department_name_en
小组编码groupcode6
小组名称Group_name
小组名称_enGroup_name_en
BC/BA编码teamcode7
BC/BA名称team_name
BC/BA名称_enteam_name_en
公司电话businessphone
公司邮箱email
国籍country
所属地区empdistrict
入职日期hiredate
离职日期quitdate
组织职务(名称)hrlevel
组织职务(Code)mlevel_code
移动电话mobile
状态servicestatus
删除标记del_flag
删除时间del_time
性别gender
信息变动时间update_time
有效雇佣日hirevalid
SF员工编码sf_empcode
成本中心costcenter
锁定标记lockflag
品牌brand
担当职务ddposition
岗位资格posqual
人事级别英文名hrlevel_en
职务描述(英文)e_title
出生日期birthday
所属部门编码sf_departmentId
所属部门名称(英文)sf_departmentName
直线主管员工编码sup_empcode
直线主管员工SF编码sup_sf_empcode
直线主管姓名sup_empname
成本中心所属公司company_costcent
商店代码description

返回结构示例

[
  {
    "company_code": "2",
    "company_short_name": "SZC",
    "empcode": "00000009",
    "c_name": "沈 若慰",
    "e_name": "ruowei shen",
    "last_name_en": "shen",
    "first_name_en": "ruowei",
    "company_name": "资生堂化妆品制造有限公司",
    "company_name_en": "Shiseido Cosmetics Manufacturing Co.,Ltd.",
    "divisioncode3": "",
    "division_name": "",
    "division_name_en": "",
    "departmentcode4": "",
    "department_name": "",
    "department_name_en": "",
    "sub_departmentcode5": "",
    "sub_department_name": "",
    "sub_department_name_en": "",
    "groupcode6": "",
    "group_name": "",
    "group_name_en": "",
    "teamcode": "",
    "team_name7": "",
    "team_name_en": "",
    "businessphone": "021-xxxxxx-xxxx",
    "email": "",
    "country": "中国",
    "empdistrict": "",
    "hiredate": "xxxx-xx-xxT00:00:00",
    "quitdate": "xxxx-xx-xxT00:00:00",
    "hrlevel": "职员",
    "mlevel_code": "A12",
    "mobile": "xxxxxxx",
    "servicestatus": "0",
    "del_flag": 0,
    "del_time": null,
    "gender": "M",
    "update_time": "2023-10-26T02:43:43.473",
    "hirevalid": "xxxx-xx-xxT00:00:00",
    "sf_empcode": "",
    "costcenter": "B1Z22ZZZZZ",
    "lockflag": 0,
    "brand": null,
    "ddposition": null,
    "posqual": null,
    "hrlevel_en": "Director",
    "e_title": null,
    "birthday": null,
    "sf_departmentid": null,
    "sf_departmentname": null,
    "sup_empcode": "",
    "sup_sf_empcode": "",
    "sup_empname": "",
    "company_costcent": "SCS",
    "description": null
  },
  {
    "company_code": "1",
    "company_short_name": "SCH",
    "empcode": "00000011",
    "c_name": "桂海平",
    "e_name": "Emily GUI",
    "last_name_en": "GUI",
    "first_name_en": "Emily",
    "company_name": "资生堂（中国）投资有限公司",
    "company_name_en": "Shiseido China Co., Ltd.",
    "divisioncode3": null,
    "division_name": "",
    "division_name_en": "",
    "departmentcode4": null,
    "department_name": "",
    "department_name_en": "",
    "sub_departmentcode5": "",
    "sub_department_name": "",
    "sub_department_name_en": "",
    "groupcode6": "",
    "group_name": "",
    "group_name_en": "",
    "teamcode": "",
    "team_name7": "",
    "team_name_en": "",
    "businessphone": "021-xxxxxx/xxxx",
    "email": "guihaiping@shiseido.cn",
    "country": "",
    "empdistrict": "上海",
    "hiredate": "2005-05-01T00:00:00",
    "quitdate": "2022-06-30T00:00:00",
    "hrlevel": "部长",
    "mlevel_code": "A01",
    "mobile": "xxxxxxx",
    "servicestatus": "0离职",
    "del_flag": 0,
    "del_time": null,
    "gender": "F",
    "update_time": "2024-07-13T03:45:26.92",
    "hirevalid": "xxxx-xx-xxT00:00:00",
    "sf_empcode": "10030201",
    "costcenter": "A1143ZZZZZ",
    "lockflag": 0,
    "brand": "Common",
    "ddposition": "NONE",
    "posqual": null,
    "hrlevel_en": "Director",
    "e_title": "Head of Employee Communication Department",
    "birthday": "xxx-xx-xxT00:00:00",
    "sf_departmentid": null,
    "sf_departmentname": null,
    "sup_empcode": "00035924",
    "sup_sf_empcode": "10031424",
    "sup_empname": "崔锐",
    "company_costcent": "SCH",
    "description": null
  }
]

3.2 地区信息查询

接口请求地址: /division
接口描述: 地区信息查询
接口调用方式: GET

请求参数说明:

字段名字段说明是否必填
pageSize单页返回数据条目，默认10N
pageNo当前页码，从0开始，默认0N
division_id按division id条件查询N
status按division status条件查询N

请求体结构示例

https://schm-api.shiseido.cn/schm-external-hr-eapi/division?pageSize=10&pageNo=0

返回结构说明

SF字段接口返回字段字段说明备注
externalCodedivision_idDivision ID
startDateeffective_as_of开始生效日期
namedivision_namedivision名称全部使用英文名
statusstatus状态A - Active / I - Inactive
cust_LegalEntityPropcompanycode公司代码当所属多个公司时，只取C0100-SCH

返回结构示例

[
  {
    "division_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division_name": "Shiseido China Innovation Center",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "division_id": "60020101",
    "effective_as_of": "2024-04-01T00:00:00",
    "division_name": "Luxury Brands Unit",
    "status": "A",
    "companycode": "C0100"
  }
]

3.3 部门信息查询

接口请求地址: /sf/department
接口描述: 部门信息查询
接口调用方式: GET

请求参数说明:

字段名字段说明是否必填
pageSize单页返回数据条目，默认10N
pageNo当前页码，从0开始，默认0N
division_id按department id条件查询N
status按department status条件查询N

请求体结构示例

https://schm-api.shiseido.cn/schm-external-hr-eapi/department?pageSize=10&pageNo=0

返回结构说明

SF字段接口返回字段字段说明备注
externalCodedepartmen_idDepartment ID
startDateeffective_as_of开始生效日期
cust_DivisionPropDivision本部如果parent为空，则为该部门的父级Division
namedepartment_name部门名称全部使用英文名
parentparent_department上级部门代码
statusstatus状态A - Active , I - Inactive
cust_LegalEntityPropcompanycode公司代码当所属多个公司时，只取C0100-SCH

返回结构示例

[
  {
    "department_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "President & C.O.O.",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "department_id": "60020002",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "Vice President",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  }
]

3.4 HK员工信息查询

接口请求地址: /employee_hk
接口描述: 查询HK员工数据。
接口调用方式: GET

请求参数说明:

字段名字段说明是否必填
pageSize单页返回数据条目，默认100N
pageNo当前页码，从0开始，默认0N
hiredate入职日期，格式yyyy-MM-dd，如：2024-07-31N
company_code公司编码N
empcode工号N
empdistrict所属地区N
quitdate离职日期，格式yyyy-MM-dd，如：2024-07-25N
mlevel_code组织职务(Code)N
servicestatus状态N
update_time信息变动时间，格式yyyy-MM-dd，如：2024-07-25N

请求体结构示例

https://schm-api.shiseido.cn/schm-external-hr-eapi/employee_hk?pageSize=10&pageNo=0

返回结构说明

返回结构与原版完全一致。

字段含义字段名称
公司编码company_code
公司略称company_short_name
工号empcode
姓名c_name
姓名_ene_name
姓(EN)last_name_en
名(EN)first_name_en
公司名称company_name
公司名称_encompany_name_en
本部编码divisioncode3
本部名称Division_name
本部名称_enDivision_name_en
部门编码departmentcode4
部门名称Department_name
部门名称_enDepartment_name_en
子部门编码sub_departmentcode5
子部门名称Sub_Department_name
子部门名称_enSub_Department_name_en
小组编码groupcode6
小组名称Group_name
小组名称_enGroup_name_en
BC/BA编码teamcode7
BC/BA名称team_name
BC/BA名称_enteam_name_en
公司电话businessphone
公司邮箱email
国籍country
所属地区empdistrict
入职日期hiredate
离职日期quitdate
组织职务(名称)hrlevel
组织职务(Code)mlevel_code
移动电话mobile
状态servicestatus
删除标记del_flag
删除时间del_time
性别gender
信息变动时间update_time
有效雇佣日hirevalid
SF员工编码sf_empcode
成本中心costcenter
锁定标记lockflag
品牌brand
担当职务ddposition
岗位资格posqual
人事级别英文名hrlevel_en
职务描述(英文)e_title
出生日期birthday
所属部门编码sf_departmentId
所属部门名称(英文)sf_departmentName
直线主管员工编码sup_empcode
直线主管员工SF编码sup_sf_empcode
直线主管姓名sup_empname
成本中心所属公司company_costcent
admin还是tradeadmin_or_trade

返回结构示例

[
  {
    "company_code": "2",
    "company_short_name": "SZC",
    "empcode": "00000009",
    "c_name": "沈 若慰",
    "e_name": "ruowei shen",
    "last_name_en": "shen",
    "first_name_en": "ruowei",
    "company_name": "资生堂化妆品制造有限公司",
    "company_name_en": "Shiseido Cosmetics Manufacturing Co.,Ltd.",
    "divisioncode3": "",
    "division_name": "",
    "division_name_en": "",
    "departmentcode4": "",
    "department_name": "",
    "department_name_en": "",
    "sub_departmentcode5": "",
    "sub_department_name": "",
    "sub_department_name_en": "",
    "groupcode6": "",
    "group_name": "",
    "group_name_en": "",
    "teamcode": "",
    "team_name7": "",
    "team_name_en": "",
    "businessphone": "021-xxxxxx-xxxx",
    "email": "",
    "country": "中国",
    "empdistrict": "",
    "hiredate": "xxxx-xx-xxT00:00:00",
    "quitdate": "xxxx-xx-xxT00:00:00",
    "hrlevel": "职员",
    "mlevel_code": "A12",
    "mobile": "xxxxxxx",
    "servicestatus": "0",
    "del_flag": 0,
    "del_time": null,
    "gender": "M",
    "update_time": "2023-10-26T02:43:43.473",
    "hirevalid": "xxxx-xx-xxT00:00:00",
    "sf_empcode": "",
    "costcenter": "B1Z22ZZZZZ",
    "lockflag": 0,
    "brand": null,
    "ddposition": null,
    "posqual": null,
    "hrlevel_en": "Director",
    "e_title": null,
    "birthday": null,
    "sf_departmentid": null,
    "sf_departmentname": null,
    "sup_empcode": "",
    "sup_sf_empcode": "",
    "sup_empname": "",
    "company_costcent": "SCS"
  },
  {
    "company_code": "1",
    "company_short_name": "SCH",
    "empcode": "00000011",
    "c_name": "桂海平",
    "e_name": "Emily GUI",
    "last_name_en": "GUI",
    "first_name_en": "Emily",
    "company_name": "资生堂（中国）投资有限公司",
    "company_name_en": "Shiseido China Co., Ltd.",
    "divisioncode3": null,
    "division_name": "",
    "division_name_en": "",
    "departmentcode4": null,
    "department_name": "",
    "department_name_en": "",
    "sub_departmentcode5": "",
    "sub_department_name": "",
    "sub_department_name_en": "",
    "groupcode6": "",
    "group_name": "",
    "group_name_en": "",
    "teamcode": "",
    "team_name7": "",
    "team_name_en": "",
    "businessphone": "021-xxxxxx/xxxx",
    "email": "guihaiping@shiseido.cn",
    "country": "",
    "empdistrict": "上海",
    "hiredate": "2005-05-01T00:00:00",
    "quitdate": "2022-06-30T00:00:00",
    "hrlevel": "部长",
    "mlevel_code": "A01",
    "mobile": "xxxxxxx",
    "servicestatus": "0离职",
    "del_flag": 0,
    "del_time": null,
    "gender": "F",
    "update_time": "2024-07-13T03:45:26.92",
    "hirevalid": "xxxx-xx-xxT00:00:00",
    "sf_empcode": "10030201",
    "costcenter": "A1143ZZZZZ",
    "lockflag": 0,
    "brand": "Common",
    "ddposition": "NONE",
    "posqual": null,
    "hrlevel_en": "Director",
    "e_title": "Head of Employee Communication Department",
    "birthday": "xxx-xx-xxT00:00:00",
    "sf_departmentid": null,
    "sf_departmentname": null,
    "sup_empcode": "00035924",
    "sup_sf_empcode": "10031424",
    "sup_empname": "崔锐",
    "company_costcent": "SCH"
  }
]

3.5 HK地区信息查询

接口请求地址: /division_hk
接口描述: HK地区信息查询
接口调用方式: GET

请求参数说明:

字段名字段说明是否必填
pageSize单页返回数据条目，默认10N
pageNo当前页码，从0开始，默认0N
division_id按division id条件查询N
status按division status条件查询N

请求体结构示例

https://schm-api.shiseido.cn/schm-external-hr-eapi/division_hk?pageSize=10&pageNo=0

返回结构说明

SF字段接口返回字段字段说明备注
externalCodedivision_idDivision ID
startDateeffective_as_of开始生效日期
namedivision_namedivision名称全部使用英文名
statusstatus状态A - Active / I - Inactive
cust_LegalEntityPropcompanycode公司代码当所属多个公司时，只取C0100-SCH

返回结构示例

[
  {
    "division_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division_name": "Shiseido China Innovation Center",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "division_id": "60020101",
    "effective_as_of": "2024-04-01T00:00:00",
    "division_name": "Luxury Brands Unit",
    "status": "A",
    "companycode": "C0100"
  }
]

3.6 HK部门信息查询

接口请求地址: /sf/department_hk
接口描述: HK部门信息查询
接口调用方式: GET

请求参数说明:

字段名字段说明是否必填
pageSize单页返回数据条目，默认10N
pageNo当前页码，从0开始，默认0N
departmen_id按department id条件查询N
status按department status条件查询N

请求体结构示例

https://schm-api.shiseido.cn/schm-external-hr-eapi/department_hk?pageSize=10&pageNo=0

返回结构说明

SF字段接口返回字段字段说明备注
externalCodedepartmen_idDepartment ID
startDateeffective_as_of开始生效日期
cust_DivisionPropDivision本部如果parent为空，则为该部门的父级Division
namedepartment_name部门名称全部使用英文名
parentparent_department上级部门代码
statusstatus状态A - Active , I - Inactive
cust_LegalEntityPropcompanycode公司代码当所属多个公司时，只取C0100-SCH

返回结构示例

[
  {
    "department_id": "60020001",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "President & C.O.O.",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  },
  {
    "department_id": "60020002",
    "effective_as_of": "2001-12-18T00:00:00",
    "division": "60020001",
    "department_name": "Vice President",
    "parent_department": "60020001",
    "status": "A",
    "companycode": "H0700"
  }
]

Reviews